﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class BinarySECSItem
 </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class BinarySECSItem
 ">
  
    <link rel="shortcut icon" href="../../favicon.ico">
    <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../../styles/docfx.css">
    <link rel="stylesheet" href="../../styles/main.css">
    <meta property="docfx:navrel" content="../../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
  
  
  
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>

        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>

              <a class="navbar-brand" href="../../index.html">
                <img id="logo" class="svg" src="../../logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>

        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">

        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem">


  <h1 id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem" class="text-break">Class BinarySECSItem
</h1>
  <div class="markdown level0 summary"><p>This class represents a SECS item with a data type of <code>B</code>
in an array form. In this case it is an array of zero or more 8-bit unsigned integers.
The C# data type is <code>byte[]</code>.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem.html">SECSItem</a></div>
    <div class="level2"><span class="xref">BinarySECSItem</span></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem.html#com_CIMthetics_CSharpSECSTools_SECSItems_SECSItem_ItemFormatCode">SECSItem.ItemFormatCode</a>
    </div>
    <div>
      <a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem.html#com_CIMthetics_CSharpSECSTools_SECSItems_SECSItem_GetSECSItemFormatCode">SECSItem.GetSECSItemFormatCode()</a>
    </div>
    <div>
      <a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem.html#com_CIMthetics_CSharpSECSTools_SECSItems_SECSItem_NumberOfLengthBytes">SECSItem.NumberOfLengthBytes</a>
    </div>
    <div>
      <a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem.html#com_CIMthetics_CSharpSECSTools_SECSItems_SECSItem_LengthInBytes">SECSItem.LengthInBytes</a>
    </div>
    <div>
      <a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem.html#com_CIMthetics_CSharpSECSTools_SECSItems_SECSItem_OutputHeaderLength">SECSItem.OutputHeaderLength()</a>
    </div>
    <div>
      <a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem.html#com_CIMthetics_CSharpSECSTools_SECSItems_SECSItem_PopulateSECSItemHeaderData_System_Byte___System_Int32_">SECSItem.PopulateSECSItemHeaderData(Byte[], Int32)</a>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.html">com.CIMthetics.CSharpSECSTools.SECSItems</a></h6>
  <h6><strong>Assembly</strong>: SECSItems.dll</h6>
  <h5 id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class BinarySECSItem : SECSItem</code></pre>
  </div>
  <h3 id="constructors">Constructors
</h3>


  <a id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem__ctor_" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.#ctor*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem__ctor" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.#ctor">BinarySECSItem()</h4>
  <div class="markdown level1 summary"><p>This constructor creates a <code>BinarySECSItem</code> with no elements.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public BinarySECSItem()</code></pre>
  </div>


  <a id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem__ctor_" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.#ctor*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem__ctor_System_Byte___com_CIMthetics_CSharpSECSTools_SECSItems_SECSItemNumLengthBytes_" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.#ctor(System.Byte[],com.CIMthetics.CSharpSECSTools.SECSItems.SECSItemNumLengthBytes)">BinarySECSItem(Byte[], SECSItemNumLengthBytes)</h4>
  <div class="markdown level1 summary"><p>This constructor creates a BinarySECSItem that will have the value of
the supplied <code>byte[]</code>.  In addition when converted to
&quot;transmission&quot; form it will use the number of length bytes
specified <strong>OR</strong> the minimum number necessary to actually contain
the length of the content of the <code>byte[]</code>.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public BinarySECSItem(byte[] value, SECSItemNumLengthBytes desiredNumberOfLengthBytes)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Byte</span>[]</td>
        <td><span class="parametername">value</span></td>
        <td><p>The value to be assigned to this <code>SECSItem</code>.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItemNumLengthBytes.html">SECSItemNumLengthBytes</a></td>
        <td><span class="parametername">desiredNumberOfLengthBytes</span></td>
        <td><p>The number of length bytes to be used for this <pre><code>SECSItem</code></pre>.
The value for the number of length bytes must be <code>ONE</code>, <code>TWO</code>, or <code>THREE</code>.
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem__ctor_System_Byte___com_CIMthetics_CSharpSECSTools_SECSItems_SECSItemNumLengthBytes__remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>The array's length should not exceed <code>16777215</code> elements.</p>
</div>


  <a id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem__ctor_" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.#ctor*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem__ctor_System_Byte___" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.#ctor(System.Byte[])">BinarySECSItem(Byte[])</h4>
  <div class="markdown level1 summary"><p>This constructor creates a BinarySECSItem that will have the value of
the supplied <code>byte[]</code>.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public BinarySECSItem(byte[] value)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Byte</span>[]</td>
        <td><span class="parametername">value</span></td>
        <td><p>An array of <code>byte</code> values to be assigned to this <code>SECSItem</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem__ctor_System_Byte____remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>The array's length should not exceed <code>16777215</code> elements.</p>
</div>
  <h3 id="properties">Properties
</h3>


  <a id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem_Value_" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.Value*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem_Value" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.Value">Value</h4>
  <div class="markdown level1 summary"><p>The value of this <code>BinarySECSItem</code>.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public byte[] Value { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Byte</span>[]</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>


  <a id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem_EncodeForTransport_" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.EncodeForTransport*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem_EncodeForTransport" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.EncodeForTransport">EncodeForTransport()</h4>
  <div class="markdown level1 summary"><p>Creates and returns a <code>byte[]</code> that represents this <code>SECSItem</code> in &quot;wire/transmission format&quot;.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override byte[] EncodeForTransport()</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Byte</span>[]</td>
        <td><p>A <code>byte[]</code> representation of this <code>SECSItem</code>'s content that is suitable for transmission.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem.html#com_CIMthetics_CSharpSECSTools_SECSItems_SECSItem_EncodeForTransport">SECSItem.EncodeForTransport()</a></div>


  <a id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem_Equals_" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.Equals*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem_Equals_System_Object_" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.Equals(System.Object)">Equals(Object)</h4>
  <div class="markdown level1 summary"><p>Determines whether the specified <span class="xref">System.Object</span> is equal to the current <a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.html">BinarySECSItem</a>.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override bool Equals(object obj)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Object</span></td>
        <td><span class="parametername">obj</span></td>
        <td><p>The <span class="xref">System.Object</span> to compare with the current <a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.html">BinarySECSItem</a>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Boolean</span></td>
        <td><p><code>true</code> if the specified <span class="xref">System.Object</span> is equal to the current
<a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.html">BinarySECSItem</a>; otherwise, <code>false</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem.html#com_CIMthetics_CSharpSECSTools_SECSItems_SECSItem_Equals_System_Object_">SECSItem.Equals(Object)</a></div>


  <a id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem_GetHashCode_" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.GetHashCode*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem_GetHashCode" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.GetHashCode">GetHashCode()</h4>
  <div class="markdown level1 summary"><p>Serves as a hash function for a <a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.html">BinarySECSItem</a> object.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><p>A hash code for this instance that is suitable for use in hashing algorithms and data structures such as a
hash table.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="com.CIMthetics.CSharpSECSTools.SECSItems.SECSItem.html#com_CIMthetics_CSharpSECSTools_SECSItems_SECSItem_GetHashCode">SECSItem.GetHashCode()</a></div>


  <a id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem_GetValue_" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.GetValue*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem_GetValue" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.GetValue">GetValue()</h4>
  <div class="markdown level1 summary"><p>Gets the value of this <code>SECSItem</code>.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">[Obsolete(&quot;This method has been deprecated, please use property Value instead.&quot;)]
public byte[] GetValue()</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Byte</span>[]</td>
        <td><p>the value of the <code>SECSItem</code>.</p>
</td>
      </tr>
    </tbody>
  </table>


  <a id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem_ToString_" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.ToString*"></a>
  <h4 id="com_CIMthetics_CSharpSECSTools_SECSItems_BinarySECSItem_ToString" data-uid="com.CIMthetics.CSharpSECSTools.SECSItems.BinarySECSItem.ToString">ToString()</h4>
  <div class="markdown level1 summary"><p>Returns a <code>string</code> representation of this item in a format
suitable for debugging.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><p>A <code>string</code> representation of this item in a format suitable for debugging.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><span class="xref">System.Object.ToString()</span></div>
</article>
          </div>

          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>In This Article</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>

      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
      
      <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>

    <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../styles/main.js"></script>
  </body>
</html>
